/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2009 Sun Microsystems, Inc.  Portions Copyrighted 2008 Richard Schilling.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 *
 * Contributor(s): Richard Schilling (coderroadie@gmail.com)
 *
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.mail.imap;

import javax.mail.*;
import javax.mail.internet.*;
import com.sun.mail.util.*;
import com.sun.mail.iap.*;
import com.sun.mail.imap.protocol.*;

/**
 * The default IMAP folder (root of the naming hierarchy).
 * 
 * @author John Mani
 */

public class DefaultFolder extends IMAPFolder {

    protected DefaultFolder(IMAPStore store) {
        super("", UNKNOWN_SEPARATOR, store);
        exists = true; // of course
        type = HOLDS_FOLDERS; // obviously
    }

    public synchronized String getName() {
        return fullName;
    }

    public Folder getParent() {
        return null;
    }

    public synchronized Folder[] list(final String pattern) throws MessagingException {
        ListInfo[] li = null;

        li = (ListInfo[]) doCommand(new ProtocolCommand() {

            public Object doCommand(IMAPProtocol p) throws ProtocolException {
                return p.list("", pattern);
            }
        });

        if (li == null)
            return new Folder[0];

        IMAPFolder[] folders = new IMAPFolder[li.length];
        for (int i = 0; i < folders.length; i++)
            folders[i] = new IMAPFolder(li[i], (IMAPStore) store);
        return folders;
    }

    public synchronized Folder[] listSubscribed(final String pattern) throws MessagingException {
        ListInfo[] li = null;

        li = (ListInfo[]) doCommand(new ProtocolCommand() {

            public Object doCommand(IMAPProtocol p) throws ProtocolException {
                return p.lsub("", pattern);
            }
        });

        if (li == null)
            return new Folder[0];

        IMAPFolder[] folders = new IMAPFolder[li.length];
        for (int i = 0; i < folders.length; i++)
            folders[i] = new IMAPFolder(li[i], (IMAPStore) store);
        return folders;
    }

    public boolean hasNewMessages() throws MessagingException {
        // Not applicable on DefaultFolder
        return false;
    }

    public Folder getFolder(String name) throws MessagingException {
        return new IMAPFolder(name, UNKNOWN_SEPARATOR, (IMAPStore) store);
    }

    public boolean delete(boolean recurse) throws MessagingException {
        // Not applicable on DefaultFolder
        throw new MethodNotSupportedException("Cannot delete Default Folder");
    }

    public boolean renameTo(Folder f) throws MessagingException {
        // Not applicable on DefaultFolder
        throw new MethodNotSupportedException("Cannot rename Default Folder");
    }

    public void appendMessages(Message[] msgs) throws MessagingException {
        // Not applicable on DefaultFolder
        throw new MethodNotSupportedException("Cannot append to Default Folder");
    }

    public Message[] expunge() throws MessagingException {
        // Not applicable on DefaultFolder
        throw new MethodNotSupportedException("Cannot expunge Default Folder");
    }
}
